home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmToggleButtonGadget.z / XmToggleButtonGadget
Encoding:
Text File  |  2002-10-03  |  43.5 KB  |  595 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt - The ToggleButtonGadget widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////TTTToooogggggggglllleeeeBBBBGGGG....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           ToggleButtonGadget sets nontransitory state data within an
  20.           application.  Usually this gadget consists of an indicator
  21.           (square or diamond-shaped) with either text or a pixmap on
  22.           one side of it.  However, it can also consist of just text
  23.           or a pixmap without the indicator.
  24.  
  25.           The toggle graphics display a 1111----ooooffff----mmmmaaaannnnyyyy or NNNN----ooooffff----mmmmaaaannnnyyyy
  26.           selection state.  When a toggle indicator is displayed, a
  27.           square indicator shows an NNNN----ooooffff----mmmmaaaannnnyyyy selection state and a
  28.           diamond-shaped indicator shows a 1111----ooooffff----mmmmaaaannnnyyyy selection state.
  29.  
  30.           ToggleButtonGadget implies a selected or unselected state.
  31.           In the case of a label and an indicator, an empty indicator
  32.           (square or diamond-shaped) indicates that ToggleButtonGadget
  33.           is unselected, and a filled indicator shows that it is
  34.           selected.  In the case of a pixmap toggle, different pixmaps
  35.           are used to display the selected/unselected states.
  36.  
  37.           The default behavior associated with a ToggleButtonGadget in
  38.           a menu depends on the type of menu system in which it
  39.           resides.  By default, BBBBSSSSeeeelllleeeecccctttt controls the behavior of the
  40.           ToggleButtonGadget.  In addition, BBBBMMMMeeeennnnuuuu controls the
  41.           behavior of the ToggleButtonGadget if it resides in a
  42.           PopupMenu system.  The actual mouse button used is
  43.           determined by its RowColumn parent.
  44.  
  45.           To accommodate the toggle indicator when created, Label's
  46.           resource XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnLLLLeeeefffftttt may be increased.
  47.  
  48.         CCCCllllaaaasssssssseeeessss
  49.           ToggleButtonGadget inherits behavior and resources from
  50.           OOOObbbbjjjjeeeecccctttt, RRRReeeeccccttttOOOObbbbjjjj, XXXXmmmmGGGGaaaaddddggggeeeetttt and XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt classes.
  51.  
  52.           The class pointer is xxxxmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeettttCCCCllllaaaassssssss.
  53.  
  54.           The class name is XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt.
  55.  
  56.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  57.           The following table defines a set of widget resources used
  58.           by the programmer to specify data.  The programmer can also
  59.           set the resource values for the inherited classes to set
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           attributes for this widget.  To reference a resource by name
  75.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  76.           prefix and use the remaining letters.  To specify one of the
  77.           defined values for a resource in a .Xdefaults file, remove
  78.           the XXXXmmmm prefix and use the remaining letters (in either
  79.           lowercase or uppercase, but include any underscores between
  80.           words).  The codes in the access column indicate if the
  81.           given resource can be set at creation time (C), set by using
  82.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  83.           not applicable (N/A).
  84.  
  85.                                         XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  86.      NNNNaaaammmmeeee                         CCCCllllaaaassssssss                        TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  87.      ________________________________________________________________________________________________________
  88.      XmNarmCallback               XmCArmCallback               XtCallbackList   NULL                   C
  89.      XmNdisarmCallback            XmCDisarmCallback            XtCallbackList   NULL                   C
  90.      XmNfillOnSelect              XmCFillOnSelect              Boolean          dynamic                CSG
  91.      XmNindicatorOn               XmCIndicatorOn               Boolean          True                   CSG
  92.      XmNindicatorSize             XmCIndicatorSize             Dimension        dynamic                CSG
  93.      XmNindicatorType             XmCIndicatorType             unsigned char    dynamic                CSG
  94.      XmNselectColor               XmCSelectColor               Pixel            dynamic                CSG
  95.      XmNselectInsensitivePixmap   XmCSelectInsensitivePixmap   Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  96.      XmNselectPixmap              XmCSelectPixmap              Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  97.      XmNset                       XmCSet                       Boolean          False                  CSG
  98.      XmNspacing                   XmCSpacing                   Dimension        4                      CSG
  99.      XmNvalueChangedCallback      XmCValueChangedCallback      XtCallbackList   NULL                   C
  100.      XmNvisibleWhenOff            XmCVisibleWhenOff            Boolean          dynamic                CSG
  101.  
  102.  
  103.           XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  104.                     Specifies a list of callbacks that is called when
  105.                     the ToggleButtonGadget is armed.  To arm this
  106.                     gadget, press the active mouse button while the
  107.                     pointer is inside the ToggleButtonGadget.  For
  108.                     this callback, the reason is XXXXmmmmCCCCRRRR____AAAARRRRMMMM.
  109.  
  110.           XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  111.                     Specifies a list of callbacks called when
  112.                     ToggleButtonGadget is disarmed.  To disarm this
  113.                     gadget, press and release the active mouse button
  114.                     while the pointer is inside the
  115.                     ToggleButtonGadget.  The gadget is also disarmed
  116.                     when the user moves out of the gadget and releases
  117.                     the mouse button when the pointer is outside the
  118.                     gadget.  For this callback, the reason is
  119.                     XXXXmmmmCCCCRRRR____DDDDIIIISSSSAAAARRRRMMMM.
  120.  
  121.           XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt
  122.                     Fills the indicator with the color specified in
  123.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr and switches the top and bottom
  124.                     shadow colors when set to True.  Otherwise, it
  125.                     switches only the top and bottom shadow colors.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     The default is set to the value of XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn.
  141.                     When XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, and XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt
  142.                     is set explicitly to True, the background is
  143.                     filled with the color specified by XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr.
  144.  
  145.           XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn
  146.                     Specifies that a toggle indicator is drawn to one
  147.                     side of the toggle text or pixmap when set to
  148.                     True.  When set to False, no space is allocated
  149.                     for the indicator, and it is not displayed.  If
  150.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is True, the indicator shadows are
  151.                     switched when the button is selected or
  152.                     unselected, but any shadows around the entire
  153.                     gadget are not switched.  However, if
  154.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, any shadows around the
  155.                     entire gadget are switched when the toggle is
  156.                     selected or unselected.
  157.  
  158.           XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrSSSSiiiizzzzeeee
  159.                     Sets the size of the indicator.  If no value is
  160.                     specified, the size of the indicator is based on
  161.                     the size of the label string or pixmap.  If the
  162.                     label string or pixmap changes, the size of the
  163.                     indicator is recomputed based on the size of the
  164.                     label string or pixmap.  Once a value has been
  165.                     specified for XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrSSSSiiiizzzzeeee, the indicator has
  166.                     that size, regardless of the size of the label
  167.                     string or pixmap, until a new value is specified.
  168.  
  169.           XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrTTTTyyyyppppeeee
  170.                     Specifies if the indicator is a 1111----ooooffff or an NNNN----ooooffff
  171.                     indicator.  For the 1111----ooooffff indicator, the value is
  172.                     XXXXmmmmOOOONNNNEEEE____OOOOFFFF____MMMMAAAANNNNYYYY.  For the NNNN----ooooffff indicator, the value
  173.                     is XXXXmmmmNNNN____OOOOFFFF____MMMMAAAANNNNYYYY.  The NNNN----ooooffff----mmmmaaaannnnyyyy indicator is
  174.                     square.  The 1111----ooooffff----mmmmaaaannnnyyyy indicator is diamond-
  175.                     shaped.  This resource specifies only the visuals
  176.                     and does not enforce the behavior.  When the
  177.                     ToggleButtonGadget is in a RadioBox, the default
  178.                     is XXXXmmmmOOOONNNNEEEE____OOOOFFFF____MMMMAAAANNNNYYYY; otherwise, the default is
  179.                     XXXXmmmmNNNN____OOOOFFFF____MMMMAAAANNNNYYYY.
  180.  
  181.           XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr
  182.                     Allows the application to specify what color fills
  183.                     the center of the square or diamond-shaped
  184.                     indicator when it is set.  If this color is the
  185.                     same as either the top or the bottom shadow color
  186.                     of the indicator, a one-pixel-wide margin is left
  187.                     between the shadows and the fill;  otherwise, it
  188.                     is filled completely.  This resource's default for
  189.                     a color display is a color between the background
  190.                     and the bottom shadow color.  For a monochrome
  191.                     display, the default is set to the foreground
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     color.  To set the background of the button to
  207.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr when XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, the
  208.                     value of XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt must be explicitly set to
  209.                     True.
  210.  
  211.           XXXXmmmmNNNNsssseeeelllleeeeccccttttIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp
  212.                     Specifies a pixmap used as the button face when
  213.                     the ToggleButtonGadget is selected and the button
  214.                     is insensitive if the LabelGadget resource
  215.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.  If the
  216.                     ToggleButtonGadget is unselected and the button is
  217.                     insensitive, the pixmap in
  218.                     XXXXmmmmNNNNllllaaaabbbbeeeellllIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp is used as the button
  219.                     face.  If no value is specified for
  220.                     XXXXmmmmNNNNllllaaaabbbbeeeellllIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp, that resource is set to
  221.                     the value specified for
  222.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttIIIInnnnsssseeeennnnssssiiiittttiiiivvvveeeePPPPiiiixxxxmmmmaaaapppp.
  223.  
  224.           XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp
  225.                     Specifies the pixmap to be used as the button face
  226.                     if XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP and the
  227.                     ToggleButtonGadget is selected.  When the
  228.                     ToggleButtonGadget is unselected, the pixmap
  229.                     specified in LabelGadget's XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is used.
  230.                     If no value is specified for XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp, that
  231.                     resource is set to the value specified for
  232.                     XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp.
  233.  
  234.           XXXXmmmmNNNNsssseeeetttt    Represents the state of the ToggleButton.  A value
  235.                     of false indicates that the ToggleButton is not
  236.                     set.   A value of true indicates that the
  237.                     ToggleButton is set.  Setting this resource sets
  238.                     the state of the ToggleButton.
  239.  
  240.           XXXXmmmmNNNNssssppppaaaacccciiiinnnngggg
  241.                     Specifies the amount of spacing between the toggle
  242.                     indicator and the toggle label (text or pixmap).
  243.  
  244.           XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  245.                     Specifies a list of callbacks called when the
  246.                     ToggleButtonGadget value is changed.  To change
  247.                     the value, press and release the active mouse
  248.                     button while the pointer is inside the
  249.                     ToggleButtonGadget.  This action also causes the
  250.                     gadget to be disarmed.  For this callback, the
  251.                     reason is XXXXmmmmCCCCRRRR____VVVVAAAALLLLUUUUEEEE____CCCCHHHHAAAANNNNGGGGEEEEDDDD.
  252.  
  253.           XXXXmmmmNNNNvvvviiiissssiiiibbbblllleeeeWWWWhhhheeeennnnOOOOffffffff
  254.                     Indicates that the toggle indicator is visible in
  255.                     the unselected state when the Boolean value is
  256.                     True.  When the ToggleButtonGadget is in a menu,
  257.                     the default value is False.  When the
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  269.  
  270.  
  271.  
  272.                     ToggleButtonGadget is in a RadioBox, the default
  273.                     value is True.
  274.  
  275.  
  276.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  277.           ToggleButtonGadget inherits behavior and resources from the
  278.           following superclasses.  For a complete description of each
  279.           resource, refer to the man page for that superclass.
  280.  
  281.                                             XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  282.      NNNNaaaammmmeeee                        CCCCllllaaaassssssss                       TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  283.      _________________________________________________________________________________________________________
  284.      XmNaccelerator              XmCAccelerator              String              NULL                   CSG
  285.      XmNacceleratorText          XmCAcceleratorText          XmString            NULL                   CSG
  286.      XmNalignment                XmCAlignment                unsigned char       dynamic                CSG
  287.      XmNfontList                 XmCFontList                 XmFontList          dynamic                CSG
  288.      XmNlabelInsensitivePixmap   XmCLabelInsensitivePixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  289.      XmNlabelPixmap              XmCLabelPixmap              Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  290.      XmNlabelString              XmCXmString                 XmString            dynamic                CSG
  291.      XmNlabelType                XmCLabelType                unsigned char       XmSTRING               CSG
  292.      XmNmarginBottom             XmCMarginBottom             Dimension           dynamic                CSG
  293.      XmNmarginHeight             XmCMarginHeight             Dimension           2                      CSG
  294.      XmNmarginLeft               XmCMarginLeft               Dimension           dynamic                CSG
  295.      XmNmarginRight              XmCMarginRight              Dimension           0                      CSG
  296.      XmNmarginTop                XmCMarginTop                Dimension           dynamic                CSG
  297.      XmNmarginWidth              XmCMarginWidth              Dimension           2                      CSG
  298.      XmNmnemonic                 XmCMnemonic                 KeySym              NULL                   CSG
  299.      XmNmnemonicCharSet          XmCMnemonicCharSet          String              dynamic                CSG
  300.      XmNrecomputeSize            XmCRecomputeSize            Boolean             True                   CSG
  301.      XmNstringDirection          XmCStringDirection          XmStringDirection   dynamic                CSG
  302.  
  303.                                     XXXXmmmmGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  304.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  305.      ___________________________________________________________________________________
  306.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic   G
  307.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL      C
  308.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic   G
  309.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False     CSG
  310.      XmNhighlightThickness   XmCHighlightThickness   Dimension          2         CSG
  311.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE    CSG
  312.      XmNshadowThickness      XmCShadowThickness      Dimension          dynamic   CSG
  313.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic   G
  314.      XmNtraversalOn          XmCTraversalOn          Boolean            True      CSG
  315.      XmNunitType             XmCUnitType             unsigned char      dynamic   CSG
  316.      XmNuserData             XmCUserData             XtPointer          NULL      CSG
  317.  
  318.                               RRRReeeeccccttttOOOObbbbjjjj RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  319.       NNNNaaaammmmeeee                   CCCCllllaaaassssssss            TTTTyyyyppppeeee        DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  320.       ____________________________________________________________________
  321.       XmNancestorSensitive   XmCSensitive     Boolean     dynamic   G
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  335.  
  336.  
  337.  
  338.       XmNborderWidth         XmCBorderWidth   Dimension   0         CSG
  339.       XmNheight              XmCHeight        Dimension   dynamic   CSG
  340.       XmNsensitive           XmCSensitive     Boolean     True      CSG
  341.       XmNwidth               XmCWidth         Dimension   dynamic   CSG
  342.       XmNx                   XmCPosition      Position    0         CSG
  343.       XmNy                   XmCPosition      Position    0         CSG
  344.  
  345.                               OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  346.       NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  347.       ____________________________________________________________________
  348.       XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  349.  
  350.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  351.           A pointer to the following structure is passed to each
  352.           callback:
  353.  
  354.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  355.           {{{{
  356.             iiiinnnntttt          _r_e_a_s_o_n;;;;
  357.             XXXXEEEEvvvveeeennnntttt       * _e_v_e_n_t;;;;
  358.             iiiinnnntttt          _s_e_t;;;;
  359.           }}}} XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  360.  
  361.  
  362.           _r_e_a_s_o_n Indicates why the callback was invoked
  363.  
  364.           _e_v_e_n_t  Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback
  365.  
  366.           _s_e_t    Reflects the ToggleButtonGadget's current state when
  367.                  the callback occurred, either True (selected) or
  368.                  False (unselected)
  369.  
  370.  
  371.         BBBBeeeehhhhaaaavvvviiiioooorrrr
  372.           XmToggleButtonGadget includes behavior from XmGadget.
  373.           XmToggleButtonGadget includes menu traversal behavior from
  374.           XmLabelGadget.  Additional XmToggleButtonGadget behavior is
  375.           described below:
  376.  
  377.  
  378.           BBBBDDDDrrrraaaagggg PPPPrrrreeeessssssss:
  379.                     Drags the contents of a ToggleButtonGadget label,
  380.                     identified by pressing BBBBDDDDrrrraaaagggg.  This action creates
  381.                     a DragContext object whose XXXXmmmmNNNNeeeexxxxppppoooorrrrttttTTTTaaaarrrrggggeeeettttssss
  382.                     resource is set to "COMPOUND_TEXT" for a label
  383.                     type of XXXXmmmmSSSSTTTTRRRRIIIINNNNGGGG; otherwise, "PIXMAP" if the label
  384.                     type is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP.  This action is undefined for
  385.                     ToggleButtonGadgets used in a menu system.
  386.  
  387.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:
  388.                     In a menu, this action unposts any menus posted by
  389.                     the ToggleButtonGadget's parent menu, disables
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 4/30/98)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  401.  
  402.  
  403.  
  404.                     keyboard traversal for the menu, and enables mouse
  405.                     traversal for the menu.  It draws the shadow in
  406.                     the armed state and, unless the button is already
  407.                     armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  408.  
  409.                     Outside a menu, if the button was previously
  410.                     unset, this action does the following:  If
  411.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is True, it draws the indicator
  412.                     shadow so that the indicator looks pressed; if
  413.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills the indicator
  414.                     with the color specified by XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr.  If
  415.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it draws the button
  416.                     shadow so that the button looks pressed.  If
  417.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp is
  418.                     used as the button face.  Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  419.                     callbacks.
  420.  
  421.                     Outside a menu, if the button was previously set,
  422.                     this action does the following:  If both
  423.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn and XXXXmmmmNNNNvvvviiiissssiiiibbbblllleeeeWWWWhhhheeeennnnOOOOffffffff are True, it
  424.                     draws the indicator shadow so that the indicator
  425.                     looks raised; if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills
  426.                     the indicator with the background color.  If
  427.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it draws the button
  428.                     shadow so that the button looks raised.  If
  429.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  430.                     used as the button face.  Calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  431.                     callbacks.
  432.  
  433.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee:
  434.                     In a menu, this action does the following:  It
  435.                     unposts all menus in the menu hierarchy.  If the
  436.                     ToggleButtonGadget was previously set, unsets it;
  437.                     if the ToggleButtonGadget was previously unset,
  438.                     sets it.  It calls the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk
  439.                     callbacks and then the XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  440.                     callbacks.
  441.  
  442.                     If the button is outside a menu and the pointer is
  443.                     within the button, this action does the following:
  444.                     If the button was previously unset, sets it; if
  445.                     the button was previously set, unsets it.  Calls
  446.                     the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  447.  
  448.                     If the button is outside a menu, calls the
  449.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  450.  
  451.           KKKKHHHHeeeellllpppp:    In a Pulldown or Popup MenuPane, unposts all menus
  452.                     in the menu hierarchy and, when the shell's
  453.                     keyboard focus policy is XXXXmmmmEEEEXXXXPPPPLLLLIIIICCCCTTTT, restores
  454.                     keyboard focus to the widget that had the focus
  455.                     before the menu system was entered.  Calls the
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 4/30/98)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  467.  
  468.  
  469.  
  470.                     callbacks for XXXXmmmmNNNNhhhheeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any exist.  If
  471.                     there are no help callbacks for this widget, this
  472.                     action calls the help callbacks for the nearest
  473.                     ancestor that has them.
  474.  
  475.           Activate: In a menu, does the following: unposts all menus
  476.                     in the menu hierarchy; unless the button is
  477.                     already armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks;
  478.                     and calls the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk and
  479.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.  Outside a menu, if
  480.                     the parent is a manager, passes the event to the
  481.                     parent.
  482.  
  483.           KKKKSSSSeeeelllleeeecccctttt:  If the ToggleButtonGadget was previously set,
  484.                     unsets it; if the ToggleButtonGadget was
  485.                     previously unset, sets it.
  486.  
  487.                     In a menu, does the following:  Unposts all menus
  488.                     in the menu hierarchy.  Unless the button is
  489.                     already armed, calls the XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  490.                     Calls the XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk and
  491.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  492.  
  493.                     Outside a menu, if the button was previously
  494.                     unset, this action does the following:  If
  495.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is True, it draws the indicator
  496.                     shadow so that the indicator looks pressed; if
  497.                     XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills the indicator
  498.                     with the color specified by XXXXmmmmNNNNsssseeeelllleeeeccccttttCCCCoooolllloooorrrr.  If
  499.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it draws the button
  500.                     shadow so that the button looks pressed.  If
  501.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNsssseeeelllleeeeccccttttPPPPiiiixxxxmmmmaaaapppp is
  502.                     used as the button face.  Calls the
  503.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk, XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk,
  504.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  505.  
  506.                     Outside a menu, if the button was previously set,
  507.                     this action does the following:  If both
  508.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn and XXXXmmmmNNNNvvvviiiissssiiiibbbblllleeeeWWWWhhhheeeennnnOOOOffffffff are True, it
  509.                     draws the indicator shadow so that the indicator
  510.                     looks raised; if XXXXmmmmNNNNffffiiiillllllllOOOOnnnnSSSSeeeelllleeeecccctttt is True, it fills
  511.                     the indicator with the background color.  If
  512.                     XXXXmmmmNNNNiiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is False, it draws the button
  513.                     shadow so that the button looks raised.  If
  514.                     XXXXmmmmNNNNllllaaaabbbbeeeellllTTTTyyyyppppeeee is XXXXmmmmPPPPIIIIXXXXMMMMAAAAPPPP, the XXXXmmmmNNNNllllaaaabbbbeeeellllPPPPiiiixxxxmmmmaaaapppp is
  515.                     used as the button face.  Calls the
  516.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk, XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk, and
  517.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.      Page 8                                          (printed 4/30/98)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))  UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV  XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  533.  
  534.  
  535.  
  536.           MMMMAAAAnnnnyyyy KKKKCCCCaaaannnncccceeeellll:
  537.                     In a toplevel Pulldown MenuPane from a MenuBar,
  538.                     unposts the menu, disarms the MenuBar
  539.                     CascadeButton and the MenuBar, and, when the
  540.                     shell's keyboard focus policy is XXXXmmmmEEEEXXXXPPPPLLLLIIIICCCCTTTT,
  541.                     restores keyboard focus to the widget that had the
  542.                     focus before the MenuBar was entered.  In other
  543.                     Pulldown MenuPanes, unposts the menu.  Outside a
  544.                     menu, if the parent is a manager, this action
  545.                     passes the event to the parent.
  546.  
  547.                     In a Popup MenuPane, unposts the menu and restores
  548.                     keyboard focus to the widget from which the menu
  549.                     was posted.
  550.  
  551.           <<<<EEEEnnnntttteeeerrrr>>>>:  In a menu, if keyboard traversal is enabled, this
  552.                     action does nothing.  Otherwise, it draws the
  553.                     shadow in the armed state and calls the
  554.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  555.  
  556.                     If the ToggleButtonGadget is not in a menu and the
  557.                     cursor leaves and then reenters the
  558.                     ToggleButtonGadget while the button is pressed,
  559.                     this action restores the button's armed
  560.                     appearance.
  561.  
  562.           <<<<LLLLeeeeaaaavvvveeee>>>>:  In a menu, if keyboard traversal is enabled, this
  563.                     action does nothing.  Otherwise, it draws the
  564.                     shadow in the unarmed state and calls the
  565.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk callbacks.
  566.  
  567.                     If the ToggleButtonGadget is not in a menu and the
  568.                     cursor leaves the ToggleButtonGadget while the
  569.                     button is pressed, this action restores the
  570.                     button's unarmed appearance.
  571.  
  572.  
  573.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  574.           The bindings for virtual keys are vendor specific.  For
  575.           information about bindings for virtual buttons and keys, see
  576.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  577.  
  578.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  579.           OOOObbbbjjjjeeeecccctttt((((3333XXXX)))), RRRReeeeccccttttOOOObbbbjjjj((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeRRRRaaaaddddiiiiooooBBBBooooxxxx((((3333XXXX)))),
  580.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))), XXXXmmmmGGGGaaaaddddggggeeeetttt((((3333XXXX)))),
  581.           XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt((((3333XXXX)))), XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))),
  582.           XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeettttGGGGeeeettttSSSSttttaaaatttteeee((((3333XXXX)))), and
  583.           XXXXmmmmTTTToooogggggggglllleeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeettttSSSSeeeettttSSSSttttaaaatttteeee((((3333XXXX)))).
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 4/30/98)
  592.  
  593.  
  594.  
  595.